<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<link href="../css/docs.css" type="text/css" rel="stylesheet" />
<link href="../css/prettify.css" type="text/css" rel="stylesheet" />
<script src="../js/prettify.js" type="text/javascript"></script>
</head>
<body onLoad="prettyPrint()">
<div class="g-unit" id="doc-content">
<div id="api-info-block">
    <div class="api-level">H3C CAS云管理平台</div>
  </div>
  <div id="jd-header">
    <h1>修改虚拟机网络配置</h1>
  </div>
</div>
<div id="jd-content">
<div class="jd-descr">
<p>修改虚拟机网络配置。</p>
<h2><a name="uri"></a>接口 URI</h2>
<p>/cas/casrs/vm/modify</p>
<h2><a name="access"></a>访问方法</h2>
<dl>
  <dt><b>HTTP 方法</b></dt>
  <dd>PUT</dd>
  <dt><b>消息体</b></dt>
  <div class="source">
  	<pre class="prettyprint lang-xml">&lt;domain&gt;<br>    &lt;id&gt;6&lt;/id&gt;<br>    &lt;name&gt;test&lt;/name&gt;<br>    &lt;network&gt;<br>        &lt;mac&gt;0c:da:41:1d:61:32&lt;/mac&gt;<br>        &lt;newMac&gt;0c:da:41:1d:61:32&lt;/newMac&gt;<br>        &lt;netType&gt;0&lt;/netType&gt;<br>        &lt;ipAddr&gt;192.168.0.214&lt;/ipAddr&gt;
        &lt;maskAddr&gt;255.255.255.0&lt;/maskAddr&gt;
        &lt;gateway&gt;192.168.0.1&lt;/gateway&gt;
        &lt;dns&gt;192.168.0.1&lt;/dns&gt;
        &lt;secondDns&gt;192.168.0.2&lt;/secondDns&gt;<br>        &lt;vsId&gt;1&lt;/vsId&gt;<br>        &lt;vsName&gt;vswitch0&lt;/vsName&gt;<br>        &lt;profileId&gt;1&lt;/profileId&gt;<br>        &lt;deviceModel&gt;e1000&lt;/deviceModel&gt;<br>        &lt;isKernelAccelerated&gt;0&lt;/isKernelAccelerated&gt;<br>	&lt;mode&gt;veb&lt;/mode&gt;<br>        &lt;vsiMngId&gt;1080::8:800:200C:417A&lt;/vsiMngId&gt;<br>        &lt;vsiTypeId&gt;222&lt;/vsiTypeId&gt;<br>        &lt;vsiTypeVer&gt;121&lt;/vsiTypeVer&gt;<br>        &lt;vsiIdFormat&gt;UUID&lt;/vsiIdFormat&gt;<br>        &lt;vsiId&gt;&lt;/vsiId&gt;<br>	&lt;hotPluggable&gt;true&lt;/hotPluggable&gt;<br>    &lt;/network&gt;<br>&lt;/domain&gt;</pre>
  </div>
</dl>

<dt><a name="detail"></a><b>元素含义</b></dt>
  <table id="pubmethods" class="jd-sumtable">
    <tbody>
      <tr>
        <th colspan="2"><span class="prettyprint lang-xml">domain</span>各子元素</th>
      </tr>
      <tr >
        <td class="jd-typecol"><span class="prettyprint lang-xml">name</span></td>
        <td width="100%" class="jd-linkcol"><span class="sympad">虚拟机名称。</span>
          <div class="jd-descrdiv">字符串（String）类型，必须。</div></td>
      </tr>
      <tr class="alt-color">
        <td class="jd-typecol"><span class="prettyprint lang-xml">id</span></td>
        <td class="jd-linkcol"><span class="sympad">虚拟机id。</span>
          <div class="jd-descrdiv">长整型（Long）类型，必须。</div></td>
      </tr>
      <tr>
        <td class="jd-typecol"><span class="prettyprint lang-xml">network</span></td>
        <td class="jd-linkcol"><span class="sympad">网络配置。</span>
          <div class="jd-descrdiv">自定义类型，必须。</div></td>
      </tr>
    </table>
	 <table id="pubmethods" class="jd-sumtable">
    <tbody>
      <tr>
        <th colspan="2">network各子元素(非SR-IOV网卡)</th>
      </tr>
      <tr >
        <td class="jd-typecol">mac</td>
        <td width="100%" class="jd-linkcol">网卡mac地址。
           
          <div class="jd-descrdiv">字符串（String）类型，必须。</div></td>
      </tr>
	  <tr class="alt-color">
        <td class="jd-typecol">netType</td>
        <td width="100%" class="jd-linkcol">网卡类型：0桥接 1NAT 2不使用网络 3物理直通网卡 。
           
          <div class="jd-descrdiv">字符串（String）类型，必须。</div></td>
      </tr>
      <tr>
        <td class="jd-typecol">newMac</td>
        <td class="jd-linkcol"><span class="sympad">要更改的目的mac地址。</span>
          <div class="jd-descrdiv">字符串（String）类型，可选项。</div></td>
      </tr>
	   <tr class="alt-color">
        <td class="jd-typecol">ipAddr</td>
        <td class="jd-linkcol"><span class="sympad">网卡绑定IP地址。</span>
          <div class="jd-descrdiv">字符串（String）类型，符合IPv4格式，可选项。</div></td>
      </tr>
	  <tr>
        <td class="jd-typecol">maskAddr</td>
        <td class="jd-linkcol"><span class="sympad">子网掩码。</span>
          <div class="jd-descrdiv">字符串（String）类型，符合子网掩码格式，可选项。</div></td>
      </tr>
	  <tr class="alt-color">
        <td class="jd-typecol">gateway</td>
        <td class="jd-linkcol"><span class="sympad">默认网关。</span>
          <div class="jd-descrdiv">字符串（String）类型，符合IPv4格式，可选项。</div></td>
      </tr>
	  <tr>
        <td class="jd-typecol">dns</td>
        <td class="jd-linkcol"><span class="sympad">首选DNS。</span>
          <div class="jd-descrdiv">字符串（String）类型，符合IPv4格式，可选项。</div></td>
      </tr>
	  <tr class="alt-color">
        <td class="jd-typecol">secondDns</td>
        <td class="jd-linkcol"><span class="sympad">备用DNS。</span>
          <div class="jd-descrdiv">字符串（String）类型，符合IPv4格式，可选项。</div></td>
      </tr>
	   <tr>
        <td class="jd-typecol"><span class="prettyprint lang-xml">vsId</span></td>
        <td class="jd-linkcol"><span class="sympad">虚拟交换机id。</span>
          <div class="jd-descrdiv">长整型（Long）类型，必须。</div></td>
      </tr>
	   <tr class="alt-color">
        <td class="jd-typecol">vsName</td>
        <td class="jd-linkcol"><span class="sympad">虚拟交换机名称。</span>
          <div class="jd-descrdiv">字符串（String）类型，必须。</div></td>
      </tr>
	  <tr>
        <td class="jd-typecol"><span class="prettyprint lang-xml">profileId</span></td>
        <td class="jd-linkcol"><span class="sympad">虚拟交换机id。</span>
          <div class="jd-descrdiv">长整型（Long）类型，必须。</div></td></tr>
	  <tr class="alt-color">
        <td class="jd-typecol"><span class="prettyprint lang-xml">deviceModel</span></td>
        <td class="jd-linkcol"><span class="sympad">网卡设备型号，枚举值：rtl8139：普通网卡;virtio：Virtio网卡;e1000：Intel e1000网卡。</span>
          <div class="jd-descrdiv">字符串（String）类型，必须。</div></td>
      </tr>
	  <tr >
        <td class="jd-typecol"><span class="prettyprint lang-xml">isKernelAccelerated</span></td>
        <td class="jd-linkcol"><span class="sympad">是否设置内核加速，当网卡设备型号为virtio时生效，枚举值：1：代表设置内核加速，0：代表不设置。</span>
          <div class="jd-descrdiv">整型（Integer）类型，默认为0。</div></td></tr>
	  <tr class="alt-color">
        <td class="jd-typecol">mode</td>
        <td class="jd-linkcol"><span class="sympad">网卡转发模式，枚举值：veb，vepa。</span>
          <div class="jd-descrdiv">字符串（String）类型，必须。</div></td>
      </tr>
	  <tr>
        <td class="jd-typecol">vsiMngId</td>
        <td class="jd-linkcol"><span class="sympad">VSI管理者ID，符合IPV6格式。</span>
          <div class="jd-descrdiv">字符串（String）类型，可选项。</div></td>
      </tr>
	  <tr class="alt-color">
        <td class="jd-typecol"><span class="prettyprint lang-xml"> </span>vsiTypeId</td>
        <td class="jd-linkcol"><span class="sympad">VSI类型ID，取值范围为：0-16777215。</span>
          <div class="jd-descrdiv">整型（Integer）类型，必须。</div></td>
      </tr>
	  <tr >
        <td class="jd-typecol">vsiTypeVer</td>
        <td class="jd-linkcol"><span class="sympad">VSI类型版本，取值范围为0-255。</span>
          <div class="jd-descrdiv">整型（Integer）类型，必须。</div></td>
      </tr>
	  <tr class="alt-color">
        <td class="jd-typecol"><span class="prettyprint lang-xml">vsiIdFormat </span></td>
        <td class="jd-linkcol"><span class="sympad">VSI 格式，目前只支持UUID。</span>
          <div class="jd-descrdiv">字符串（String）类型，必须。</div></td>
      </tr>
	   <tr>
        <td class="jd-typecol">vsiId</td>
        <td class="jd-linkcol"><span class="sympad">VSI 实例ID，必须符合UUID格式：XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX（8-4-4-12，每个X代表一个十六进制数[0-9|a-f]）。</span>
          <div class="jd-descrdiv">字符串（String）类型，必须。</div></td>
      </tr>
	  <tr class="alt-color">
        <td class="jd-typecol"><span class="prettyprint lang-xml">hotPluggable</span></td>
        <td class="jd-linkcol"><span class="sympad">热拔。（true：允许，false：不允许）</span>
          <div class="jd-descrdiv">布尔（Boolean）类型，可选。</div></td>
      </tr>
  </table>
   <table id="pubmethods" class="jd-sumtable">
    <tbody>
      <tr>
        <th colspan="2">network各子元素(SR-IOV网卡)</th>
      </tr>
      <tr >
        <td class="jd-typecol">mac</td>
        <td width="100%" class="jd-linkcol">网卡mac地址。
           
          <div class="jd-descrdiv">字符串（String）类型，必须。</div></td>
      </tr>
	  <tr class="alt-color">
        <td class="jd-typecol">netType</td>
        <td width="100%" class="jd-linkcol">网卡类型：4:SR-IOV网卡。
          <div class="jd-descrdiv">字符串（String）类型，必须。</div></td>
      </tr>
      <tr>
        <td class="jd-typecol">newMac</td>
        <td class="jd-linkcol"><span class="sympad">要更改的目的mac地址。</span>
          <div class="jd-descrdiv">字符串（String）类型，可选项。</div></td>
      </tr>
      <tr  class="alt-color">
        <td class="jd-typecol"><span class="prettyprint lang-xml">driverType</span></td>
        <td class="jd-linkcol"><span class="sympad">驱动类型，枚举值：VFIO：VFIO设备分配处理，KVM：KVM内核处理</span>
          <div class="jd-descrdiv">字符串（String）类型，可选项。</div></td>
      </tr>
      <tr>
        <td class="jd-typecol"><span class="prettyprint lang-xml">vlan</span></td>
        <td class="jd-linkcol"><span class="sympad">VLAN</span>
          <div class="jd-descrdiv">整型（Integer）类型，可选项。</div></td>
      </tr>
  </table>
	<h2><a name="result"></a>返回结果</h2>
<dl>
  <dt><b>状态码</b></dt>
  <dd>
  <ul>
    <li>204(No Content)：成功。</li>
    <li>409(Conflict)：失败。 </li>
  </ul>
  </dd>
  <dt><b>消息头</b></dt>
  <div class="source"><pre class="prettyprint lang-xml">HTTP/1.1 204 No Content<br>Server: Apache-Coyote/1.1<br>Date: Mon, 25 Nov 2013 12:52:27 GMT
  </pre>
  </div>
  <dt><b>消息体</b></dt>
  <div class="source">
    <pre class="prettyprint lang-xml">HTTP/1.1 200 OK<br>Server: Apache-Coyote/1.1<br>Set-Cookie: JSESSIONID=BDF7B4EDFDBA9FBF003D195F802D705F; Path=/imcrs<br>Date: Fri, 23 Dec 2011 04:44:21 GMT
&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;<br>&lt;taskMsg&gt;<br>  &lt;msgId&gt;1393831560400&lt;/msgId&gt;<br>  &lt;name&gt;修改虚拟机“test”网络“ 0c:da:41:1d:61:32--&gt;0c:da:41:1d:61:32 ”成功。&lt;/name&gt;<br>  &lt;detail&gt;修改虚拟机“test”网络“ 0c:da:41:1d:61:32--&gt;0c:da:41:1d:61:32 ”。&lt;/detail&gt;<br>  &lt;completed&gt;false&lt;/completed&gt;<br>  &lt;progress&gt;0&lt;/progress&gt;<br>&lt;/taskMsg&gt;</pre>
  </div>
</dl>
<dt>
    <h2><a name="example"></a>应用举例</h2>
    <p>修改虚拟机test网卡<span class="prettyprint lang-xml">0c:da:41:1d:61:32</span>的配置。</p>
    <dl>
      <dt><b>请求</b></dt>
      <div class="source">
        <pre class="prettyprint lang-xml">POST http://192.168.0.4:8080/cas/casrs/vm/modify
accept: application/xml


&lt;domain&gt;<br>    &lt;id&gt;6&lt;/id&gt;<br>    &lt;name&gt;test&lt;/name&gt;<br>    &lt;network&gt;<br>        &lt;mac&gt;0c:da:41:1d:61:32&lt;/mac&gt;<br>        &lt;newMac&gt;0c:da:41:1d:61:32&lt;/newMac&gt;<br>        &lt;netType&gt;0&lt;/netType&gt;<br>        &lt;ipAddr&gt;192.168.0.214&lt;/ipAddr&gt;<br>        &lt;vsId&gt;1&lt;/vsId&gt;<br>        &lt;vsName&gt;vswitch0&lt;/vsName&gt;<br>        &lt;profileId&gt;1&lt;/profileId&gt;<br>        &lt;deviceModel&gt;e1000&lt;/deviceModel&gt;<br>        &lt;isKernelAccelerated&gt;0&lt;/isKernelAccelerated&gt;<br>	&lt;mode&gt;veb&lt;/mode&gt;<br>        &lt;vsiMngId&gt;1080::8:800:200C:417A&lt;/vsiMngId&gt;<br>        &lt;vsiTypeId&gt;222&lt;/vsiTypeId&gt;<br>        &lt;vsiTypeVer&gt;121&lt;/vsiTypeVer&gt;<br>        &lt;vsiIdFormat&gt;UUID&lt;/vsiIdFormat&gt;<br>        &lt;vsiId&gt;&lt;/vsiId&gt;<br>	&lt;hotPluggable&gt;true&lt;/hotPluggable&gt;<br>    &lt;/network&gt;<br>&lt;/domain&gt;
</pre>
      </div>
      <dt><b>回应</b></dt>
      <div class="source"><pre class="prettyprint lang-xml">HTTP/1.1 200 OK<br>Server: Apache-Coyote/1.1<br>Set-Cookie: JSESSIONID=BDF7B4EDFDBA9FBF003D195F802D705F; Path=/imcrs<br>Date: Fri, 23 Dec 2011 04:44:21 GMT
&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;<br>&lt;taskMsg&gt;<br>  &lt;msgId&gt;1393831560400&lt;/msgId&gt;<br>  &lt;name&gt;修改虚拟机“test”网络“ 0c:da:41:1d:61:32--&gt;0c:da:41:1d:61:32 ”成功。&lt;/name&gt;<br>  &lt;detail&gt;修改虚拟机“test”网络“ 0c:da:41:1d:61:32--&gt;0c:da:41:1d:61:32 ”。&lt;/detail&gt;<br>  &lt;completed&gt;false&lt;/completed&gt;<br>  &lt;progress&gt;0&lt;/progress&gt;<br>&lt;/taskMsg&gt;</pre>
      </div>
    </dl>
</div>
</div>
</div>
</body>
</html>